<html>
<head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <title>execution::submit</title>
    <link rel="stylesheet" href="../../boostbook.css" type="text/css">
    <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
    <link rel="home" href="../../index.html" title="Asio">
    <link rel="up" href="../reference.html" title="Reference">
    <link rel="prev" href="execution__start.html" title="execution::start">
    <link rel="next" href="execution_context.html" title="execution_context">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%">
    <tr>
        <td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="execution__start.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u"
                                                                                              href="../reference.html"><img
        src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png"
                                                                                      alt="Home"></a><a accesskey="n"
                                                                                                        href="execution_context.html"><img
        src="../../next.png" alt="Next"></a>
</div>
<div class="section">
    <div class="titlepage">
        <div>
            <div><h3 class="title">
                <a name="asio.reference.execution__submit"></a><a class="link" href="execution__submit.html"
                                                                  title="execution::submit">execution::submit</a>
            </h3></div>
        </div>
    </div>
    <p>
        <a class="indexterm" name="asio.indexterm.execution__submit"></a>
    </p>
    <p>
        A customisation point that submits a sender to a receiver.
    </p>
    <pre class="programlisting"><span class="keyword">constexpr</span> <span class="identifier">unspecified</span> <span
            class="identifier">submit</span> <span class="special">=</span> <span
            class="identifier">unspecified</span><span class="special">;</span>
</pre>
    <p>
        The name <code class="computeroutput"><span class="identifier">execution</span><span
            class="special">::</span><span class="identifier">submit</span></code> denotes a customisation point object.
        For some subexpressions <code class="computeroutput"><span class="identifier">s</span></code>
        and <code class="computeroutput"><span class="identifier">r</span></code>, let <code
            class="computeroutput"><span class="identifier">S</span></code> be a type such that <code
            class="computeroutput"><span class="keyword">decltype</span><span class="special">((</span><span
            class="identifier">s</span><span class="special">))</span></code>
        is <code class="computeroutput"><span class="identifier">S</span></code> and let <code
            class="computeroutput"><span class="identifier">R</span></code> be a type such that <code
            class="computeroutput"><span class="keyword">decltype</span><span class="special">((</span><span
            class="identifier">r</span><span class="special">))</span></code>
        is <code class="computeroutput"><span class="identifier">R</span></code>. The expression <code
            class="computeroutput"><span class="identifier">execution</span><span class="special">::</span><span
            class="identifier">submit</span><span class="special">(</span><span class="identifier">s</span><span
            class="special">,</span> <span class="identifier">r</span><span class="special">)</span></code> is
        ill-formed if <code class="computeroutput"><span class="identifier">sender_to</span><span
            class="special">&lt;</span><span class="identifier">S</span><span class="special">,</span>
        <span class="identifier">R</span><span class="special">&gt;</span></code>
        is not <code class="computeroutput"><span class="keyword">true</span></code>. Otherwise, it is
        expression-equivalent to:
    </p>
    <div class="itemizedlist">
        <ul class="itemizedlist" type="disc">
            <li class="listitem">
                <code class="computeroutput"><span class="identifier">s</span><span class="special">.</span><span
                        class="identifier">submit</span><span class="special">(</span><span
                        class="identifier">r</span><span class="special">)</span></code>,
                if that expression is valid and <code class="computeroutput"><span class="identifier">S</span></code>
                models <code class="computeroutput"><span class="identifier">sender</span></code>. If the
                function selected does not submit the receiver object <code class="computeroutput"><span
                    class="identifier">r</span></code>
                via the sender <code class="computeroutput"><span class="identifier">s</span></code>, the
                program is ill-formed with no diagnostic required.
            </li>
            <li class="listitem">
                Otherwise, <code class="computeroutput"><span class="identifier">submit</span><span
                    class="special">(</span><span class="identifier">s</span><span class="special">,</span> <span
                    class="identifier">r</span><span class="special">)</span></code>,
                if that expression is valid and <code class="computeroutput"><span class="identifier">S</span></code>
                models <code class="computeroutput"><span class="identifier">sender</span></code>, with overload
                resolution performed in a context that includes the declaration <code class="computeroutput"><span
                    class="keyword">void</span> <span class="identifier">submit</span><span
                    class="special">();</span></code> and that does not include a declaration
                of <code class="computeroutput"><span class="identifier">execution</span><span class="special">::</span><span
                    class="identifier">submit</span></code>. If the function selected by
                overload resolution does not submit the receiver object <code class="computeroutput"><span
                    class="identifier">r</span></code> via the sender <code class="computeroutput"><span
                    class="identifier">s</span></code>,
                the program is ill-formed with no diagnostic required.
            </li>
            <li class="listitem">
                <p class="simpara">
                    Otherwise, <code class="computeroutput"><span class="identifier">execution</span><span
                        class="special">::</span><span class="identifier">start</span><span
                        class="special">((</span><span class="keyword">new</span> <span class="identifier">submit_receiver</span><span
                        class="special">&lt;</span><span class="identifier">S</span><span class="special">,</span> <span
                        class="identifier">R</span><span class="special">&gt;{</span><span
                        class="identifier">s</span><span class="special">,</span><span class="identifier">r</span><span
                        class="special">})-&gt;</span><span class="identifier">state_</span><span
                        class="special">)</span></code>,
                    where <code class="computeroutput"><span class="identifier">submit_receiver</span></code>
                    is an implementation-defined class template equivalent to:
                </p>
                <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span><span
                        class="keyword">class</span> <span class="identifier">S</span><span
                        class="special">,</span> <span class="keyword">class</span> <span
                        class="identifier">R</span><span class="special">&gt;</span>
  <span class="keyword">struct</span> <span class="identifier">submit_receiver</span> <span class="special">{</span>
    <span class="keyword">struct</span> <span class="identifier">wrap</span> <span class="special">{</span>
      <span class="identifier">submit_receiver</span> <span class="special">*</span> <span
                            class="identifier">p_</span><span class="special">;</span>
      <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span><span
                            class="special">...</span><span class="identifier">As</span><span
                            class="special">&gt;</span>
        <span class="identifier">requires</span> <span class="identifier">receiver_of</span><span
                            class="special">&lt;</span><span class="identifier">R</span><span
                            class="special">,</span> <span class="identifier">As</span><span
                            class="special">...&gt;</span>
      <span class="keyword">void</span> <span class="identifier">set_value</span><span class="special">(</span><span
                            class="identifier">As</span><span class="special">&amp;&amp;...</span> <span
                            class="identifier">as</span><span class="special">)</span> <span
                            class="special">&amp;&amp;</span>
        <span class="keyword">noexcept</span><span class="special">(</span><span class="identifier">is_nothrow_receiver_of_v</span><span
                            class="special">&lt;</span><span class="identifier">R</span><span
                            class="special">,</span> <span class="identifier">As</span><span
                            class="special">...&gt;)</span> <span class="special">{</span>
        <span class="identifier">execution</span><span class="special">::</span><span
                            class="identifier">set_value</span><span class="special">(</span><span class="identifier">std</span><span
                            class="special">::</span><span class="identifier">move</span><span
                            class="special">(</span><span class="identifier">p_</span><span class="special">-&gt;</span><span
                            class="identifier">r_</span><span class="special">),</span> <span
                            class="special">(</span><span class="identifier">As</span><span
                            class="special">&amp;&amp;)</span> <span class="identifier">as</span><span class="special">...);</span>
        <span class="keyword">delete</span> <span class="identifier">p_</span><span class="special">;</span>
      <span class="special">}</span>
      <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">class</span> <span
                            class="identifier">E</span><span class="special">&gt;</span>
        <span class="identifier">requires</span> <span class="identifier">receiver</span><span
                            class="special">&lt;</span><span class="identifier">R</span><span
                            class="special">,</span> <span class="identifier">E</span><span class="special">&gt;</span>
      <span class="keyword">void</span> <span class="identifier">set_error</span><span class="special">(</span><span
                            class="identifier">E</span><span class="special">&amp;&amp;</span> <span class="identifier">e</span><span
                            class="special">)</span> <span class="special">&amp;&amp;</span> <span class="keyword">noexcept</span> <span
                            class="special">{</span>
        <span class="identifier">execution</span><span class="special">::</span><span
                            class="identifier">set_error</span><span class="special">(</span><span class="identifier">std</span><span
                            class="special">::</span><span class="identifier">move</span><span
                            class="special">(</span><span class="identifier">p_</span><span class="special">-&gt;</span><span
                            class="identifier">r_</span><span class="special">),</span> <span
                            class="special">(</span><span class="identifier">E</span><span
                            class="special">&amp;&amp;)</span> <span class="identifier">e</span><span
                            class="special">);</span>
        <span class="keyword">delete</span> <span class="identifier">p_</span><span class="special">;</span>
      <span class="special">}</span>
      <span class="keyword">void</span> <span class="identifier">set_done</span><span class="special">()</span> <span
                            class="special">&amp;&amp;</span> <span class="keyword">noexcept</span> <span
                            class="special">{</span>
        <span class="identifier">execution</span><span class="special">::</span><span class="identifier">set_done</span><span
                            class="special">(</span><span class="identifier">std</span><span
                            class="special">::</span><span class="identifier">move</span><span
                            class="special">(</span><span class="identifier">p_</span><span class="special">-&gt;</span><span
                            class="identifier">r_</span><span class="special">));</span>
        <span class="keyword">delete</span> <span class="identifier">p_</span><span class="special">;</span>
      <span class="special">}</span>
    <span class="special">};</span>
    <span class="identifier">remove_cvref_t</span><span class="special">&lt;</span><span
                            class="identifier">R</span><span class="special">&gt;</span> <span
                            class="identifier">r_</span><span class="special">;</span>
    <span class="identifier">connect_result_t</span><span class="special">&lt;</span><span
                            class="identifier">S</span><span class="special">,</span> <span
                            class="identifier">wrap</span><span class="special">&gt;</span> <span class="identifier">state_</span><span
                            class="special">;</span>
    <span class="identifier">submit_receiver</span><span class="special">(</span><span class="identifier">S</span><span
                            class="special">&amp;&amp;</span> <span class="identifier">s</span><span
                            class="special">,</span> <span class="identifier">R</span><span
                            class="special">&amp;&amp;</span> <span class="identifier">r</span><span
                            class="special">)</span>
      <span class="special">:</span> <span class="identifier">r_</span><span class="special">((</span><span
                            class="identifier">R</span><span class="special">&amp;&amp;)</span> <span
                            class="identifier">r</span><span class="special">)</span>
      <span class="special">,</span> <span class="identifier">state_</span><span class="special">(</span><span
                            class="identifier">execution</span><span class="special">::</span><span class="identifier">connect</span><span
                            class="special">((</span><span class="identifier">S</span><span
                            class="special">&amp;&amp;)</span> <span class="identifier">s</span><span
                            class="special">,</span> <span class="identifier">wrap</span><span
                            class="special">{</span><span class="keyword">this</span><span
                            class="special">}))</span> <span class="special">{}</span>
  <span class="special">};</span>
</pre>
            </li>
        </ul>
    </div>
    <h5>
        <a name="asio.reference.execution__submit.h0"></a>
        <span><a name="asio.reference.execution__submit.requirements"></a></span><a class="link"
                                                                                    href="execution__submit.html#asio.reference.execution__submit.requirements">Requirements</a>
    </h5>
    <p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">asio/execution/submit.hpp</code>
    </p>
    <p>
        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio/execution.hpp</code>
    </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%">
    <tr>
        <td align="left"></td>
        <td align="right">
            <div class="copyright-footer">Copyright © 2003-2022 Christopher M. Kohlhoff<p>
                Distributed under the Boost Software License, Version 1.0. (See accompanying
                file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
            </p>
            </div>
        </td>
    </tr>
</table>
<hr>
<div class="spirit-nav">
    <a accesskey="p" href="execution__start.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u"
                                                                                              href="../reference.html"><img
        src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png"
                                                                                      alt="Home"></a><a accesskey="n"
                                                                                                        href="execution_context.html"><img
        src="../../next.png" alt="Next"></a>
</div>
</body>
</html>
